Templates Page

The Templates page of the well test configuration control defines a list of all the defined header templates. The configurations differs depending on the template type:

Commands can also be defined at the header template level. These commands can be referenced by commands at the position level.

The Templates page consists of the following sections:

Screen designer tip:
You can hide this page by disabling the Show templates property in the Canvas Design view.

Templates page - Host type no Sub-headers

Click the thumbnail to see the Templates page:
Host-based configuration with no Sub-headers

  

Templates page - Host type with Sub-headers

Click the thumbnail to see the Templates page:
Host-based configuration with Sub-headers

  

Templates page - Device type with Sub-headers

Click the thumbnail to see theTemplates page:
Device-based configuration with Sub-headers

To configure Well Test Header Templates

Perform the following steps to configure the header templates properties, referring to the property definitions below:

  1. Click the Templates tab on the left side of the screen.
  2. Click to Add template or click on previously configured template.
  3. Configure the template Type, and Queue UDC.
  4. Click to Add command or edit a previously configured command.
  1. Click to Add action to a command and configure the action's properties. Repeat as necessary and click OK.
  1. Host Type Templates only. Click to Add position or edit previously configured position.
  1. Configure the position values and click to Add command or edit a previously configured command.
  1. Click to Add action to a command and configure the action's properties. Repeat as necessary and click OK.
  1. Save any changes.
  2. The Well test Configuration is now ready to execute.
  3. See Sample Well Test Screens and Scripts for more information.

Templates

The Templates section of the Templates page defines a list of all the defined header templates to be included in each well test operation.

Property Description XML

Name

Specifies the name of the header template. This name is used in the Header configuration.

name

Add template

  • Click Add template to add a new header template.
  • Select <New Template> in the grid and type a new name for this header template.
  • Configure the Properties, Commands, and Positions for the new header template and the areas on the right. Configuration options are described below.
  

Delete template

  • Click Delete this item to delete a selected header template, as necessary.
  

Properties

The Properties section of the Templates page defines general header template items.

Property Description XML

Name

Specifies the name of the header template. This name is used in the Header configuration.

name

Type

Two supported template types are supported:

  • Host-based — in this mode, the host is responsible for the sequencing of commands to the device
  • Device-based — in this mode, the device is responsible for the sequencing of commands to the device and the host is monitoring that process

Note: Device-based templates do not have Positions.

type

Queue UDC

Specifies the UDC to use for the header queue. This is an override value that can be used if a different UDC is needed for whatever reason. E.g., QUEUE.

queueUdc

Commands

The Properties section of the Templates page defines the commands associated with this header template. The actions defined in each command will be executed when the header queue point is updated with one of these values.

Command configuration

Click the thumbnail to see the
Command configuration dialog box
Property Description XML

Name

Specifies the name of the command.

The following is a list of reserved type names for each command:

  • START

type

Add command

To add a command

  • Click Add command to add a new command to this header template.
  • Select <New Command> in the grid and type a new name for this command.
  • Click Edit this item to edit a selected command. The Command Configuration dialog box will appear.
  • Click Add action to add a new action to this command.
  • Select the appropriate action from the drop-down menu. Options include:
  • Click Edit true action or the action type name to edit the action.
  • Click Delete this item to delete the action type, as necessary.
  • Repeat to add as many actions as required.
  • See each action type listed above for user assistance.
  • Click OK to close the Command Configuration dialog box.
  

Edit command

  • Click Edit this item to edit a selected command. The Command Configuration dialog box will appear.
  

Delete command

  • Click Delete this item to delete a selected command, as necessary.
  

Positions

The Positions section of the Templates page defines the positions associated with this header template for host-based templates. See Positions, Headers, and Sub-Headers for more information.

Header Position Configuration

Click the thumbnail to see the
Header Position Configuration dialog box
Property Description XML

Has sub-headers

For host-based templates:

Indicates whether the template supports sub-headers, which are the cross-reference between the unique position of the header template to the sub-header and sub-header position where the well is connected. Options include True or False.

See Positions, Headers, and Sub-Headers for more information.

  • Click the Has sub-headers check box to reveal the Sub-header and Sub-header position columns, where you can add sub-headers and sub-header positions for this template.

hasSubHeaders

Number

Specifies the number of the position. This is referenced in the Well configuration. Values include 1, 2, 3, …, n.

number

Name

Specifies a unique identifier (position) on the well testing facility. This integer value is often the value returned by a device at the test facility to indicate which well is being tested or has been tested. The nice name of the position. Values include: Position 1, Position 2, …, Position n.

name

Sub-header

Specifies a text-based descriptor of the sub-header/header within the well test facility to which the position is connected. This description, in combination with sub-header position, should represent a unique value.

subHeader

Sub-header position

Specifies a text-based descriptor of the position on the sub-header to which the unique position identifier is connected.

subHeaderPosition

Add position

To add a position

  • Click Add position to add a new position to this header template.
  • Select the new position in the grid and type a Number, Name, for this position. For host-based templates add the Sub-header, and Sub-header position for this position.
  • Click Edit this item to edit a selected position. The Header Position Configuration dialog box will appear.
  • Click Add command to add a new command to this position.
  • Select <New Command> in the grid and type a new name for this command or select a previously configured position.
  • A Command configuration area will appear to the right where you will define the Action types associated with this command.
  • Click Add action to add a new action to this command.
  • Select the appropriate action from the drop-down menu. Options include:
  • Select the action type to edit the action. An Action configuration area will appear to the right where you can configure the properties for each Action types associated with this command.
  • Repeat to add as many actions to this command as required.
  • Click Delete this item to delete selected action properties, commands, or positions, as necessary.
  • Click OK to close the Header Position Configuration dialog box.
  

Edit position

  • Click Edit this item to edit a selected position. The Header Position Configuration dialog box will appear.
  

Delete position

  • Click Delete this item to delete a selected position, as necessary.
  

Sub-header configuration

The Sub-header section of the Templates page defines the positions, sub-headers, and sub-header positions associated with this header template for device-based templates. See Positions, Headers, and Sub-Headers for more information.

Sub-header configuration

Click the thumbnail to see the
Sub-header configuration
Property Description XML

Has sub-header

For device-based templates:

Indicates whether the template supports sub-headers, which are the cross-reference between the unique position of the header template to the sub-header and sub-header position where the well is connected. Options include True or False.

See Positions, Headers, and Sub-Headers for more information.

  • Click the Has sub-headers check box to reveal the Sub-headers configuration grid, where you can add positions, sub-headers and sub-header positions for this template.

hasSubheaders

Position

Specifies a unique identifier (position) on the well testing facility. This integer value is often the value returned by a device at the test facility to indicate which well is being tested or has been tested. The nice name of the position. Values include: Position 1, Position 2, …, Position n.

name

Sub-header

Specifies a text-based descriptor of the sub-header/header within the well test facility to which the position is connected. This description, in combination with sub-header position, should represent a unique value.

subHeader

Sub-header position

Specifies a text-based descriptor of the position on the sub-header to which the unique position identifier is connected.

subHeaderPosition

Delete position

  • Click Delete this item to delete a selected sub-header, as necessary.
  

More:

ArrowExit Action Type

ArrowHeader Command Action Type

ArrowMonitor Action Type

ArrowPoint Value Compare Action Type

ArrowScript Action Type

ArrowSet Point Action Type

ArrowTest Action Type

ArrowUIS Command Action Type

Back to top